/*
 * Copyright (C) 2020  AniTrend
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

package co.anitrend.core.android.binding

import androidx.viewbinding.ViewBinding

/**
 * View binding contract for UI controllers
 *
 * @property binding The binding property that represents a view
 */
interface IBindingView<B: ViewBinding> {

    var binding: B?

    /**
     * Assures that the binding reference is null safe
     *
     * @return Non null reference of [binding]
     * @throws IllegalArgumentException If [binding] is nullable
     */
    @Throws(IllegalArgumentException::class)
    fun requireBinding(): B = requireNotNull(binding)
}